home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / bbs_util / db2ftp94.zip / DBQ2FTP.DOC < prev    next >
Text File  |  1996-04-07  |  22KB  |  526 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.    ┌───────────┐
  10.    └───┐ ┌───┐ │ ┌──────┐ ┌──────┐  ┌───────┐  ┌──────┐┌─────────┐┌────────┐
  11.        │ │   │ │ │ ┌──┐ └┐│ ┌──┐ │  │ ┌───┐ │  │ ┌────┘└───┐ ┌───┘│ ┌────┐ │
  12.        │ │   │ │ │ │  └┐ ││ │  │ │  └─┘   │ │  │ │         │ │    │ │    │ │
  13.        │ │   │ │ │ └───┘ ││ │  │ │  ┌─────┘ │  │ └──┐      │ │    │ └────┘ │
  14.        │ │   │ │ │ ┌───┐ ││ │  │ │  │ ┌─────┘  │ ┌──┘      │ │    │ ┌──────┘
  15.        │ │   │ │ │ │   │ ││ │  │ │  │ │        │ │         │ │    │ │
  16.    ┌───┘ └───┘ │ │ └───┘ ││ └──┘ │  │ └─────┐  │ │         │ │    │ │
  17.    └───────────┘ └───────┘└─────┐└┐ └───────┘  └─┘         └─┘    └─┘
  18.                                 └─┘
  19.          ───────────────────────────────────────────────────────────
  20.                      D'Bridge Queue To FTP Version 0.94ß
  21.          ───────────────────────────────────────────────────────────
  22.  
  23.                                  Khile Klock
  24.                             The Computer Hotline!
  25.                                 (503) 928-9535
  26.                                300 - 14,400 Bps
  27.                               FidoNet   1:357/1
  28.                               FidoNet   1:357/2
  29.                              FamilyNet   8:7706/0
  30.                              hotline@proaxis.com
  31.                           klockk@hotlin.fidonet.org
  32.  
  33.          ───────────────────────────────────────────────────────────
  34.  
  35.                          Documentation Updated 4/07/96
  36.  
  37.      DBQ2FTP v0.94ß                                                Page ii
  38.  
  39.       
  40.  
  41.       Important Information - Please Note: 
  42.       ─────────────────────────────────── 
  43.  
  44.         This version of DBQ2FTP is a wide  ßeta!  What's that mean?  Well,
  45.       I've tested  it enough to  ensure  it works  on my  system,  and I'm
  46.       currently running three FTPMail links  using  this software.  Before
  47.       you install this software,  it is recommended that  you first make a
  48.       backup of your hard disk, or at least  all your configuration files.
  49.  
  50.         I don't say  this because  I expect  problems,  but I have no idea
  51.       whether  this software  will function  on your system.   If it does,
  52.       I can't  guarantee  what it  will do.  I DO know  what it SHOULD do,
  53.       and let's hope it does.
  54.  
  55.         If you are  running this software,  I expect to hear  from you so I
  56.       know who is running it!  I also expect  you to send me bug reports so
  57.       I can fix the bugs and improve the  software.  If you wish to send in
  58.       a feature request,  please send  it to any of the addresses listed at
  59.       the end of this  documentation, along  with complete  descriptions of
  60.       what your bug or feature request is, and how it might be implemented.
  61.  
  62.  
  63.      DBQ2FTP v0.94ß                                                 Page 1
  64.  
  65.  
  66.  
  67.       What is DBQ2FTP?
  68.       ────────────────
  69.  
  70.         DBQ2FTP (D'Bridge Queue to FTP) is a program designed to take care
  71.       of the problem of getting D'Bridge in it's native mode to interface
  72.       with FTPMail setups.
  73.  
  74.         Since D'Bridge has a completely unique mail handling setup, i.e.
  75.       NetMail and Echomail are managed via a series of queue files generated
  76.       by D'Bridge, and are NOT anything like standard FidoNet Mail handling
  77.       formated files. All of the current MOVEMAIL type programs available
  78.       today simply do NOT work when it comes to D'Bridge. (In fact, I was
  79.       told "Good Luck!" when I first started looking into setting up a FTP-
  80.       Mail system.
  81.  
  82.         DBQ2FTP simply Bridges (Pardon the pun) the gap between D'Bridge
  83.       and the more traditional FidoNet Style Packets and Arcmail, including
  84.       NetMail, and FTSC compliant file naming conventions.
  85.  
  86.         This in turn allows one to make use of FTP Type programs for manag-
  87.       ing FTPMail.  I use KA9Q for my setup, and will use that for my
  88.       examples in this documentation.
  89.  
  90.       Legal Stuff
  91.       ───────────
  92.       
  93.         Not that anything  should go wrong,  but there are  no implied war-
  94.       ranties, or guarantees that come with this program.  If you choose to
  95.       use it,  you take all responsibility for whatever happens if some un-
  96.       natural act should happen.
  97.       
  98.  
  99.       Necessary Stuff
  100.       ───────────────
  101.  
  102.         You will need to be running "D'Bridge",  and there's an  assumption
  103.       that  you are  looking at  this  documentation  so you  can  get your
  104.       D'Bridge  system  interfaced with  a  program like  KA9Q  for FTPMail
  105.       transfer.
  106.       
  107.  
  108.       New in Version 0.94ß
  109.       --------------------
  110.  
  111.         This is the third  official wide ßeta of DBQ2FTP!  Given the proper
  112.       configuration file,  DBQ2FTP  will scan  your D'Bridge queue for out-
  113.       bound  Netmail Packets,  XMail,  Areafix Requests,  and File Attaches
  114.       looking  for  D'Bridge  queue  entries  destined  for the  configured
  115.       destination node.  More than one FTPFeed can now be configured within
  116.       a single configuration file!  You can now also control which priority
  117.       of NetMail and XMail are sent via FTPMail!
  118.  
  119.  
  120.      DBQ2FTP v0.94ß                                                 Page 2
  121.  
  122.       
  123.  
  124.       How Does it Work?
  125.       ─────────────────
  126.       
  127.         Once DBQ2FTP is installed, everything is automatic,  but of course,
  128.       at first you have to set the bugger up yourself.
  129.  
  130.         DBQ2FTP  takes  a  look at your  D'Bridge generated  Disk-Based Que
  131.       directory  and looks  for entries for your configured FTPFEED System.
  132.       Once  the entries  are found,  DBQ2FTP will  handle the  movement and
  133.       generation  of  FTSC  Compliant  packets,  ArcMail  and  File  Attach
  134.       (XMIT) Entries (This includes  misc.  items as ".TIC" files and their
  135.       associated file echo files,  Outbound AreaFix requests,  and D'Bridge
  136.       Routed NetMail (Based on your D'Bridge  routing setup for the current
  137.       Event.)).
  138.  
  139.         To set up DBQ2FTP,  you will need to  edit the supplied DBQ2FTP.CFG
  140.       configuration file  using your favorite text editor,  like QEdit,  or
  141.       vi for you unix folks <Grin>.
  142.     
  143.         Just follow the examples, and you'll have DBQ2FTP configured in re-
  144.       cord time!  Here is what you'll see when you enter  the configuration
  145.       file.
  146.       
  147.       Example Configuration File:
  148.       ───────────────────────────
  149.  
  150.         Look for the file named DBQ2FTP, this is your example.
  151.  
  152.       Configuration Definitions:
  153.       ──────────────────────────
  154.  
  155.       ;         Anything following a semi-colon is considered a comment and
  156.                 wil be ignored. (Blank lines are also ignored.)
  157.  
  158.       SYSOP     This should be self explanitory. If not, ask your mom!
  159.  
  160.       NODE      Enter your  fully  qualitied 4  dimentional FidoNet Address
  161.                 after this KEY WORD. (If you don't want to use 4D addressing,
  162.                 we'll drop back to 3D with a warning and assume point = 0.)
  163.  
  164.       LOGFILE   Enter the full path  and  filename of the  file you wish to
  165.                 have  runtime info  logged  into.  If you only  specify the
  166.                 log  filename  itself,  the  log  will  be  created  in the
  167.                 directory you run DBQ2FTP from.
  168.  
  169.        NETDIR   Enter the full drive and path to your *.Msg NetMail
  170.                 directory.
  171.  
  172.        PKTDIR   Enter the full drive and path to your packet directory.
  173.                 Note: In D'Bridge's setup, it's called the "Temporary
  174.                       Que path".
  175.  
  176.        QUEDIR   Enter the full drive and path to your QUE (Disk-Based Que)
  177.                 directory.
  178.                 Note: In D'Bridge's setup, it's called the "Outbound Que
  179.                       path".
  180.      DBQ2FTP v0.94ß                                                 Page 3
  181.  
  182.  
  183.  
  184.        FTPIN    Enter the full drive and path to your inbound FTP directory
  185.                 where your KA9Q (or other application) scripts will receive
  186.                 your FTPMail into.
  187.  
  188.                 Note: This KEY WORD is currenty looked for, but implementa-
  189.                       tion is not  yet complete.  DBQ2FTP currently doesn't
  190.                       currently do  anything for you in  regards to inbound
  191.                       FTPMail. (Stay tuned for future releases!)
  192.  
  193.       BEGIN    This KEY WORD marks the BEGINing of the FTPFeed block.
  194.                Between  this BEGIN key word,  and the END keyword,  you
  195.                will define your FTPFeed information. Multiple BEGIN/END
  196.                pairs can be defined for multiple FTPFeeds.
  197.  
  198.       FTPFEED  Enter the fully  qualitied 4 dimentional FidoNet Address
  199.                of your FTPMail feed after this KEY WORD.  (If you don't
  200.                want to use 4D addressing,  we'll drop back to 3D with a
  201.                warning.)
  202.  
  203.        FTPOUT  Enter  the  full  drive  and path to  your  outbound FTP
  204.                directory.  This is the  directory that will be uploaded
  205.                to your FTP feed  by your KA9Q  (or  other  application)
  206.                scripts. When DBQ2FTP is run, anything found / generated
  207.                for  this  FTPFeed  will  be  placed  in  this  outbound
  208.                directory.
  209.  
  210.        SEND_CRASH  Send Messages marked CRASH.  By default, messages marked
  211.                    with a CRASH  priority  are  not  processed  by  DBQ2FTP,
  212.                    leaving  them in  place  for your mailer  to deliver via
  213.                    regular  telephone calls  to  your FTPFeed.  Using  this
  214.                    option will tell  DBQ2FTP to  process  CRASH messages as
  215.                    well.
  216.  
  217.        SEND_IMM    Send Messages  marked IMMediate.   By default,  messages
  218.                    marked with an IMMediate priority are  not processed  by
  219.                    DBQ2FTP, but left alone to  be delivered by your mailer,
  220.                    via regular telephone calls to your FTPFeed.  Using this
  221.                    option will have DBQ2FTP process these messages also.
  222.  
  223.        END         This marks the END of the BEGIN/END FTPFeed block.
  224.                    Between  this  END  key  word,  and a previosuly defined
  225.                    BEGIN keyword, you will define your FTPFeed information.
  226.                    Multiple  BEGIN/END  pairs  can be  defined for multiple
  227.                    FTPFeeds.
  228.  
  229.         Now you will need to  edit the batch  file that you  use to  export
  230.       your FTP outbound Net/Echomail and  associated files.  (i.e.  Areafix
  231.       Requests, Files attaches, etc)
  232.  
  233.  
  234.  
  235.      DBQ2FTP v0.94ß                                                 Page 4
  236.       
  237.  
  238.  
  239.       Editing your batch file 
  240.       ─────────────────────── 
  241.  
  242.         You  will need to have DBQ2FTP running from the batch file that you
  243.       import  your  echomail from.  Here are  some examples  of some  batch 
  244.       files  that deal with  incoming  mail and call  DBQ2FTP in a standard
  245.       environment. 
  246.  
  247.         In  standard mode, DBQ2FTP  recognizes "DBQ2FTP.CFG" as the default
  248.       configuration  file and expects that file to reside in the same drive
  249.       and directory you  executed DBQ2FTP  from.  If you place  DBQ2FTP  in
  250.       some out-of-the  way place that is in your path  (like "C:\Utility"),
  251.       when you execute DBQ2FTP,  the program is going to expect the default
  252.       configuration file, "DBQ2FTP.CFG", to reside in the same place.
  253.  
  254.         DBQ2FTP has optional  command  line parameters,  and that allow you
  255.       over-ride the default configuration file as well as the location of
  256.       your configuration file(s).
  257.  
  258.         -C   This command line parameter allows you to over-ride the default
  259.              configuration file name. Example: -CSSTRBONE.CFG
  260.  
  261.         -D   This command line paramater instructs DBQ2FTP to display "DEBUG"
  262.              information as it's processing your D'Bridge Queue directories.
  263.  
  264.         -H   Displays these  command-line options so you  don't always have
  265.              to read these DOCS.
  266.  
  267.         -P   This command line parameter allows you to over-ride the default
  268.              location of the configuration file(s). Example: I:\NOS
  269.  
  270.         -T   This command line paramater instructs DBQ2FTP to run in "TEST"
  271.              mode.  This means that DBQ2FTP will not mark SENT or KILL any
  272.              netmail it processed, nor will it DELETE or TRUNCATE any files
  273.              that were attached to the NetMail messages. Note however that
  274.              the  files  WILL be copied  and  the  FTSC Type-2 packet WILL
  275.              be created.
  276.  
  277.              Warning: If you run in this mode, you CAN create  DUPLICATES,
  278.                       which could get you in trouble with your feed.
  279.  
  280.         -V   This option will LOG the debug information to your log file.
  281.  
  282.      DBQ2FTP v0.94ß                                                 Page 5
  283.       
  284.  
  285.  
  286.       If you  use the  standard  mode of  operation  configuration  filename
  287.       (DBQ2FTP.CFG),  you  may omit  the "-C"  parameter,  although  you may
  288.       still wish to indicate it's location with the "-P" parameter.
  289.  
  290.       ──────────────────────────────────────
  291.             cd \nos
  292.  
  293.               Rem Move Zstar outbound archives from D'Bridge outbound
  294.               Rem to ftp transfer directory
  295.  
  296.             DBQ2FTP -cSSTRBONE.CFG    «─ Call DBQ2FTP w/Config parameter
  297.  
  298.               Rem If you wish to copy your outbound files before sending,
  299.               Rem you need to insert something here!
  300.  
  301.               Rem Start Internet connection
  302.               Rem Use direct screen writes, verbose mode off
  303.             net15b -d\nos rgn17.net
  304.  
  305.               Rem Inbound pre-processing and copying...
  306.             call rgn-in.btm
  307.       ──────────────────────────────────────
  308.  
  309.  
  310.       What will it look like?
  311.       ───────────────────────
  312.  
  313.         DBQ2FTP will append to the configured LOG file file as follows:
  314.                                                        
  315.     ─────────────────────────────────────
  316.     DBQ2FTP v0.94ß system log file
  317.     ─────────────────────────────────────
  318.  
  319.     *******************************************************
  320.     Begin
  321.     Operating as node..............: 1:357/1.0
  322.     System Operator................: Khile Klock
  323.     Network mail path..............: I:\DB\MAIL-OUT
  324.     D'Bridge Packet path...........: I:\DB\PACKETS
  325.     D'Bridge outbound queue path...: I:\DB\ARCMAIL
  326.     FTP inbound path...............: I:\DB\FILES-IN\FTP-IN
  327.     FTP Feed address # 1 ..........: 1:138/146.0
  328.     FTP outbound path..............: I:\DB\FTP-OUT\RGN17
  329.     D'Bridge outbound queue name...: 00103U.042
  330.     Messages marked CRASH will be sent.
  331.     Messages marked IMMediate will be sent.
  332.     FTP Feed address # 2 ..........: 1:396/1.0
  333.     FTP outbound path..............: I:\DB\FTP-OUT\SSTRBONE
  334.     D'Bridge outbound queue name...: 0010B0.001
  335.     Messages marked CRASH will be sent.
  336.     Network mail directory contains: 13 messages
  337.       numbered 1 to 16.
  338.     No outbound packets found for.
  339.     No outbound X-Mail found.
  340.     End
  341.  
  342.      DBQ2FTP v0.94ß                                                 Page 6
  343.       
  344.  
  345.  
  346.         Ofcourse, the date and time will appear down the left column of the
  347.       log file so you can see when stuff is happening.
  348.  
  349.       Now What?
  350.       ─────────
  351.  
  352.         Nothing  else  needs  to be  done! Once you get echomail coming in
  353.       and going out via FTPMail link(s), DBQ2FTP will do the rest as far as
  354.       getting your mail from D'Bridge to the FTP Directory!
  355.  
  356.       
  357.       Note: 
  358.       ─────
  359.  
  360.         DBQ2FTP  may  be  run from any directory you wish, but it is always
  361.       advised that you run it from your main NOS or D'Bridge directory.
  362.  
  363.         Also, the first time you run DBQ2FTP, you will see a warning entry
  364.       in the log file as follows:
  365.  
  366.    01/13/96 22:51:18  Warning: Unable to open I:\NOS\00dbff6f.INF!
  367.    01/13/96 22:51:18  Warning: Unable to retrieve ArcMail History Information!
  368.    01/13/96 22:51:18  No outbound X-Mail found.
  369.    01/13/96 22:51:18  End
  370.    01/13/96 22:53:18  *******************************************************
  371.  
  372.       This is to be expected since DBQ2FTP hasn't created it's special info
  373.       file to keep track of ArcMail bundles.  This will  go away  after the
  374.       first run for EACH  FTPMail system  you connect to.  If this  warning
  375.       persists, you'ld better investigate what's going on.  DBQ2FTP creates
  376.       a special ".INF" info file for each system you connect to.  This file
  377.       is written in the same directory as your  configuration file for that
  378.       system.  The file name is the difference between the FEED address and
  379.       YOUR address in HEX,  just the same as the  FTSC ArcMail file  naming
  380.       convention, with a ".INF" extention.
  381.  
  382.      DBQ2FTP v0.94ß                                                 Page 7
  383.  
  384.  
  385.  
  386.  
  387.       Error Level Exits:
  388.       ──────────────────
  389.  
  390.       DBQ2FTP will normally exit with an error level = 0,  unless something
  391.       goes wrong, or there is need to warn the user about something.
  392.  
  393.       The following  is a  breakdown of the  various errorlevel exits,  and
  394.       what they mean:
  395.  
  396.           0 = Everything went ok, something was moved
  397.  
  398.           1 = Warnings exist, Something was moved.
  399.  
  400.           2 = Everything went ok, nothing was moved.
  401.  
  402.         251 = Found outbound Que File,
  403.               Can't Open it! Regenerate your DB Queue! (ALT-Q)
  404.  
  405.         252 = Can't seem to open actual outbound Packet!
  406.               Regenenerate your DB Queue! (ALT-Q)
  407.  
  408.         253 = Found Packet "Que" File, Can't Open it!
  409.               Regenerate your DB Queue! (ALT-Q)
  410.  
  411.         254 = Configuration file incomplete!
  412.  
  413.         255 = Configuration file missing!
  414.  
  415.  
  416.      DBQ2FTP v0.94ß                                                 Page 8
  417.  
  418.  
  419.  
  420.  
  421.       Registration Cost:
  422.       ──────────────────
  423.  
  424.                               Evaluation Period:
  425.                               ──────────────────
  426.  
  427.       DBQ2FTP is being released as "Share Ware".   I'll share my  work with
  428.       you, and you can try it out.  If you find that this suits your needs,
  429.       then  you are requested to send  the author  a check  to help support
  430.       the future of this software. Future versions will be released as time
  431.       permits and the  need arrises.  If you already sent in your registra-
  432.       tion check, then you're already registered for the next release!
  433.  
  434.       It's assumed that 30 - 60 days is more than enough time to "evaluate"
  435.       this product,  after wich  you  either make a decision  to send  in a
  436.       registration check, or perform the graceful act "DEL DBQ*.*".
  437.       (Although I won't hold my breath!)
  438.  
  439.  
  440.                                 Standard Site:
  441.                                 ──────────────
  442.  
  443.       Standard registration of DBQ2FTP is $5.00 US Funds  (See DBQ2FTP.REG
  444.       file). Laser printed documentation, and  official  software diskette,
  445.       can be obtained for an additional $5.00,  simply to cover the cost of
  446.       manual production, diskettes, shipping and handling
  447.  
  448.  
  449.                                Commercial Site:
  450.                                ────────────────
  451.  
  452.       Commercial registrations of  DBQ2FTP run $20.00 which  includes laser
  453.       printed  documentation,  software on  disk in  either  5.25" or  3.5"
  454.       format, and a certificate of registration.
  455.       
  456.  
  457.       All funds should be sent to:
  458.  
  459.                           Around the Klock Software
  460.                           Att: Khile Klock 
  461.                           626 SW 3rd Ave.
  462.                           Albany, Oregon 97321-0509
  463.  
  464.       Make checks payable to: Khile T. Klock
  465.  
  466.  
  467.         Be sure to fill out the registration form "DBQ2FTP.REG" enclosed in
  468.       this  package. It  will help to insure that your registration will be 
  469.       processed correctly and as quickly as possible. 
  470.  
  471.  
  472.      DBQ2FTP v0.94ß                                                 Page 9
  473.  
  474.  
  475.  
  476.         If  you have any suggestions, comments, or questions  please direct
  477.       them to:
  478.  
  479.                                  Khile Klock
  480.  
  481.                             The Computer Hotline!
  482.                                 (503) 928-9535
  483.                                 (503) 928-7330
  484.                                300 - 14,400 Bps
  485.                               FidoNet   1:357/1
  486.                               FidoNet   1:357/2
  487.                               Network   8:7706/0
  488.  
  489.                              hotline@proaxis.com
  490.                           klockk@hotlin.fidonet.org
  491.  
  492.       Support:
  493.       --------
  494.  
  495.         I am hosting a mailing list here at hotlin.fidonet.org.   For more
  496.         information, send E-Mail to listserv@hotlin.fidonet.org or to auto
  497.         subscribe,  send E-Mail to dbq2ftp-s@hotlin.fidonet.org.  Messages
  498.         should be posted to dbq2ftp@atksoft.hotlin.fidonet.org.
  499.  
  500.         I also have the DBQ2FTP echo area, if you wish to feed that way.
  501.  
  502.         (Future)
  503.         Look for new versions of DBQ2FTP on the web at the following URL:
  504.         http://www.proaxis.com/~hotline.  You may also find copies via
  505.         ftp at ftp.island.net, ftp.sstar.com, or ptmudge.westsound.com.
  506.  
  507.  
  508.       Acknowledgments:
  509.       ────────────────
  510.  
  511.         1) Marc Blakely       - For reworking KA9Q to allow FTPMail!
  512.                                 And putting up with my numerous test
  513.                                 messages!
  514.  
  515.         2) John Mudge         - Rumagin' through my documentation.
  516.                                 (I aso hear he's pushin' for a version
  517.                                  for FrontDoor!)
  518.  
  519.         3) John Souvestre     - Puttin' up with my test messages!
  520.  
  521.         4) D'Bridge Users     - For testing this stuff out for me!
  522.  
  523.         5) My Wife!           - Just plain putting up with me!
  524.  
  525.  
  526.